Starting the Scheme Payment Processing Process Host-to-host
Endpoint: /api/h2h/start
Parameters passed:
| Field | Field description |
|---|---|
| payment_id | Tracking number of the payment order in the client's accounting system |
| session | Session H2H identifier received during payment processing |
Example request: { "payment_id": "12345", "session": "6EEB-220B-FB62-3405-0C57-65FA-0C4C-F6D4" }
Success Example: { "is_white": false, "session": "01777a77-210b-43d4-ad2d-9599825fc12d", "result": true, "next_step": "process", "final": false, "data": { "cardNumber": { "field": "cardNumber", "title": "Card number", "placeholder": "4444111144441111", "hidden": false, "required": true }, "month": { "field": "month", "title": "Expiry month", "placeholder": "12", "hidden": false, "required": true }, "year": { "field": "year", "title": "Expiry year", "placeholder": "25", "hidden": false, "required": true }, "cvv": { "field": "cvv", "title": "CVV", "placeholder": "***", "hidden": false, "required": true }, "cardHolder": { "field": "cardHolder", "title": "Cardholder name", "placeholder": "CARDHOLDER NAME", "hidden": false, "required": true } } }
List of returned fields:
| Field | Field description |
|---|---|
| error | Error description |
| session | session identifier within which the query is being executed |
| payment_id | Payment identifier on the merchant's side |
| result | Result of the query execution (successful execution or not) |
| next_step | next step editor (/api/h2h/{step-idetifcatorr}) where to send the filled data received in the field data |
| final | The session is in the final stages or not |
| data |
A set of data that should be requested from the user in order to proceed with the operation. Data is represented from messages from objects: field -The name of the field (the identifier with which the data should be transmitted in the next step) title - Field description placeholder - Example of filling in the field hidden - hidden field or not required - Is it mandatory to fill in the field or not |